home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / GIPV201.ARJ / INSTALL.DOC < prev    next >
Text File  |  1992-01-29  |  7KB  |  147 lines
  1.                           Generic Install Program
  2.  
  3.                                   ver 2.0
  4.  
  5.                                      by
  6.  
  7.                            Kenneth E. Sandquist Jr.
  8.  
  9.                           ---------------------------
  10.  
  11.      Generic Install Program (GIP) is a 'programmers tool' to allow you to
  12. install your software packages with a professional look!  After all, isn't
  13. the installation of your package the first thing people see?
  14.  
  15.      GIP has several nice features that can alleviate the hassle and extra
  16. code in you programs.  It allows for minimum memory amount checking, available
  17. disk drive space, 32-bit CRC checking, and existing file and directory checks!
  18. All this is done in a nice, professional 3-D type screen.
  19.  
  20.      To use GIP, a file is required (INSTALL.LST) to tell GIP what files to
  21. install, where to install them, and file CRC's and sizes.  There are two ways
  22. to create this file:
  23.  
  24.      1) Use the utility provided as part of this package called CREATE.EXE.
  25.      To use CREATE, copy ALL files that you want to include in the install
  26.      to a sub-directory of its own (a temporary sub-directory is fine...we just
  27.      need to separate these files from ones we don't need!) and then type:
  28.        C:\TEMP> CREATE
  29.      That's it! CREATE will then proceed to gather up the files in the
  30.      directory.  Then, CREATE will ask you three questions:
  31.        a) Enter the install directory name for this list:
  32.        Enter the name of the directory you would like the user to install
  33.        your package in.
  34.  
  35.        b) Enter main executable name for this list:
  36.        Type in the name that starts your application (extension is optional!).
  37.        Hit return and the default name is "NONE".
  38.  
  39.        c) Enter minimum amount of memory required:
  40.        Hitting return will default this value to 384,000 bytes.  The number
  41.        you enter here should be the LEAST amount of memory your software will
  42.        require.
  43.  
  44.      Then CREATE will calculate the CRC values for each file it found and
  45.      record them, along with the file sizes, in the list.
  46.  
  47.      2) Use your favorite ASCII text editor and create a file called
  48.      INSTALL.LST and record the information as follows:
  49.  
  50.      LINE
  51.      ----
  52.      1  | XXXXXXXX.XXX  <--- Directory name here
  53.      2  | XXXXXXXX.XXX  <--- Main executable name here
  54.      3  | 012345        <--- Minimum required memory
  55.  
  56. *don't   1  File name  14 15 File size 27 28  CRC  36
  57. *include [..............] [.............] [.........]
  58.      4  | XXXXXXXX.XXX     0123456789012   0A1B2C3D4
  59.      Repeat line four for the number of files you want to install.
  60.      To calculate the CRC value for a file type:
  61.           C:\TEMP> CREATE -C XXXXXXXX.XXX
  62.      CREATE will then supply you with the CRC value of that file!
  63.  
  64. As you can probably tell, the way to go is to let CREATE do all of the work!
  65.  
  66.  
  67.  
  68.  
  69.      CREATE also has two more command line switches:
  70.  
  71.       1) -U to update the files in the list with new CRC's if the files have
  72.       been changed.  This is useful if you have just updated your program and
  73.       don't want to have to go through the entire CREATE process...CREATE will
  74.       update CRC's where needed and quit!
  75.  
  76.       2) -O to override the built in 'skip' of including the files:
  77.          INSTALL.EXE
  78.          CREATE.EXE
  79.       Basically, when CREATE runs without this option, it creates a list file
  80.       with these two files EXCLUDED from the list!  This is done to keep from
  81.       installing the no-longer-needed INSTALL programs.  However, using this
  82.       switch allows the INSTALL program to install itself along with your
  83.       software.
  84.  
  85.      Once the list file is created, you're ready to install!  Just copy all of
  86. the files in the temporary directory we discussed earlier to a floppy and
  87. you're ready!
  88.  
  89.      Have the user type INSTALL at the DOS prompt and INSTALL will take over
  90. with little or no help from the user.  INSTALL will ask the user to enter the
  91. drive to install onto (default = C:).  Then it will ask them to enter the
  92. directory name where they would like to install your package (your preferred
  93. directory name is shown as the default...they can either hit ENTER or type in
  94. their own directory!).  If the specified directory already exists on the
  95. drive, the installer is warned that it exists and is prompted to either quit
  96. or continue to use that directory.  The next, and in most cases the last,
  97. step is to hit any key to start the install.  That's it!  If INSTALL comes
  98. across a filename that already exists in the path specified, the user is
  99. prompted to overwrite the file.  They can enter 1 of 3 answers:
  100.  
  101.       1) Y - yes, I want to overwrite this file!
  102.       2) N - no, skip this file and go on!
  103.       3) A - yes, I want to overwrite this file and all others that may exist!
  104.  
  105. At any time during the install, the user can hit the ESC key to stop the
  106. program and prompt them to abort.
  107.  
  108. ERRORS:
  109.  
  110.      There is only one message that, under normal circumstances, should appear
  111. in the MESSAGES window and that is XXXXXXXX.XXX Bad CRC!  This is not a
  112. serious error; However, it is advisable to have the installer inform you of
  113. this error and what file it occurred on.  What this error means is that the
  114. file in error no longer matches the CRC value in the INSTALL.LST file.  There
  115. could be several reasons for this: bad disk, old CRC value in the list, or the
  116. file has been altered.  It's up to you, the programmer, to decide what the
  117. user should do when this error occurs...INSTALL will still install the file
  118. with just a warning to the user!
  119.  
  120. -----------------------------------------------------------------------------
  121.                            Who is Vision Software?
  122.  
  123.      Vision Software was created by the author Kenneth E. Sandquist Jr.
  124.  
  125.                         3187A Aqueduct Drive
  126.                         Lexington, KY 40517
  127.  
  128. -----------------------------------------------------------------------------
  129.  
  130.  
  131.  
  132.  
  133.                                  Disclaimer
  134.  
  135.           INSTALL is distributed as-is.  The author disclaims all
  136.           warranties, expressed or implied.  The author will assume
  137.           no liability for damages either from the direct use of this
  138.           product or as a consequence of the use of this product.
  139. -----------------------------------------------------------------------------
  140.                                   Register?
  141.  
  142.      Although any contribution would be appreciated (hint! hint!), If you
  143. find this program of some use, pass it along to a friend...Right now I'm
  144. looking for recognition not, so much, money.  HOWEVER...don't be shy with the
  145. ol' checkbook !!!  If you do make a contribution, you will be given the next
  146. release along with any other utilities I come up with between now and then!
  147. Not to mention you'll get, free of charge, a clear conscience!